pp108 : Reloading Runtime References

Reloading Runtime References
This topic describes when and how to reload runtime references.

The reuse of application artifacts is supported through runtime references. See Reusing Application Artifacts for more information on which application artifacts can be reused.

Information stored in a runtime reference can become outdated when compared to the deployed version of the referenced artifact due to various reasons. One of the reasons may be that the contract of the referenced artifact has changed since the time of creating or last reloading the runtime reference.

Publishing a project or a single document, which includes a runtime reference that is outdated will fail. It must be reloaded to make the runtime reference up-to-date again.

To reload a runtime reference:

  1. In Workspace Documents, expand the project hierarchy up to the folder in which the runtime reference is located.
  2. Right-click the <runtime reference> and select Reload Reference.

The command-line tool with which all the runtime references in a workspace can be reloaded with a single action is as follows:

ReloadRuntimeReferences <organization name> <workspace name> [-execute]

The command-line tool accepts the following parameters where:

  • <organization name> is the name of the organization
  • <workspace name> is the name of the workspace
  • -execute is an optional parameter. This option causes all the outdated runtime references to be reloaded. Without this option, a test run will be performed.

To reload all the runtime references using the command-line tool:

  1. Log in to the Process Platform server.
  2. Open a command prompt and navigate to the folder <Process_Platform_Installation_Directory>/components/cws/scripts. In a Windows environment, you must navigate to the subfolder windows; for a Linux environment, you must navigate to the subfolder linux.
  3. Run the tool with the proper parameters.

Note: The user who executes the tool must have a Process Platform user account with the user ID set as the user name of the operating system user account. The Process Platform user must be assigned the Developer role in the organization in which the workspace resides.

Few examples on how to run the command-line tool, including sample output is as follows:

Example 1: Command to trigger a test run of reloading runtime references in the workspace "My Workspace" in the organization "My Organization" 
~>ReloadRuntimeReference "My Organization" "My Workspace"
Starting ReloadRuntimeReferences
 
This is a test run. Runtime references will not be reloaded.
 
The runtime reference MyProject/RuntimeRoles/Tester has been reloaded.
 
Verifying runtime references, 100% completed.
 
This was a test run. No runtime references have been modified. To reload all the runtime references, use the option '-execute'.
 
All runtime references have been processed.
Example 2: Command to reload all the outdated runtime references in the workspace "My Workspace" in the organization "My Organization" 
~>ReloadRuntimeReferences "My Organization" "My Workspace" -execute
Starting ReloadRuntimeReferences
 
The runtime reference MyProject/RuntimeRoles/Tester has been reloaded
 
Verifying runtime references, 100% completed.
 
All runtime references have been processed.